Platform Explorer / Nuxeo Platform 2023.14

Operation Directory.CreateVocabularyEntry (Vocabulary: Add Entry)

In component org.nuxeo.ecm.core.automation.features.operations

Description

Add a new entry in the vocabularyName vocabulary only if id is not found (an existing entry isnot updated). If label is empty, it is set to the id. WARNING: Current user must have enough rights to write in a vocabulary.
Operation id Directory.CreateVocabularyEntry
Category Services
Label Vocabulary: Add Entry
Requires
Since

Parameters

Name Description Type Required Default value
id string yes  
vocabularyName string yes  
label string no  
obsolete long no  
ordering long no  
parent string no  

Signature

Inputs void
Outputs void

Implementation Information

Implementation Class Class: org.nuxeo.ecm.automation.core.operations.services.directory.CreateVocabularyEntry
Contributing Component org.nuxeo.ecm.core.automation.features.operations

JSON Definition

{
  "id" : "Directory.CreateVocabularyEntry",
  "label" : "Vocabulary: Add Entry",
  "category" : "Services",
  "requires" : null,
  "description" : "Add a new entry in the <i>vocabularyName</i> vocabulary only if <i>id</i> is not found (an existing entry isnot updated). If <i>label</i> is empty, it is set to the id. WARNING: Current user must have enough rights to write in a vocabulary.",
  "url" : "Directory.CreateVocabularyEntry",
  "signature" : [ "void", "void" ],
  "params" : [ {
    "name" : "id",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "vocabularyName",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "label",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "obsolete",
    "description" : null,
    "type" : "long",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "ordering",
    "description" : null,
    "type" : "long",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "parent",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}